Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ES|QL] Change function_named_parameters in Kibana doc to expected format #121585

Merged

Conversation

fang-xing-esql
Copy link
Member

Change the type of function named parameter from function named parameters to the expected format -function_named_parameters the generated Kibana docs

@fang-xing-esql fang-xing-esql added >docs General docs changes auto-backport Automatically create backport pull requests when merged :Analytics/ES|QL AKA ESQL ES|QL-ui Impacts ES|QL UI v9.0.0 v8.18.0 v8.18.1 v8.19.0 v9.0.1 v9.1.0 labels Feb 3, 2025
Copy link
Contributor

github-actions bot commented Feb 3, 2025

Documentation preview:

Copy link
Contributor

github-actions bot commented Feb 3, 2025

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@@ -30,7 +30,7 @@
}
],
"examples" : [
"FROM books \n| WHERE KQL(\"author: Faulkner\")\n| KEEP book_no, author \n| SORT book_no \n| LIMIT 5;"
"FROM books \n| WHERE KQL(\"author: Faulkner\")\n| KEEP book_no, author \n| SORT book_no \n| LIMIT 5"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recapture the kibana doc changes related to KQL, QSTR and MATCH operator on main.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Fang!

@fang-xing-esql fang-xing-esql marked this pull request as ready for review February 4, 2025 15:50
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Feb 4, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytical-engine (Team:Analytics)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/kibana-esql (ES|QL-ui)

Copy link
Member

@carlosdelest carlosdelest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:100

@@ -254,7 +254,7 @@ public Match(
valueHint = { "none", "all" },
description = "Number of beginning characters left unchanged for fuzzy matching."
) },
description = "Match additional options as <<esql-function-named-params,function named parameters>>."
description = "(Optional) Match additional options as <<esql-function-named-params,function named parameters>>."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call adding this :+1

@@ -30,7 +30,7 @@
}
],
"examples" : [
"FROM books \n| WHERE KQL(\"author: Faulkner\")\n| KEEP book_no, author \n| SORT book_no \n| LIMIT 5;"
"FROM books \n| WHERE KQL(\"author: Faulkner\")\n| KEEP book_no, author \n| SORT book_no \n| LIMIT 5"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Fang!

@fang-xing-esql fang-xing-esql merged commit f58fdf8 into elastic:main Feb 4, 2025
16 checks passed
fang-xing-esql added a commit to fang-xing-esql/Elasticsearch that referenced this pull request Feb 4, 2025
…rmat (elastic#121585)

* change function_named_parameters in kibana doc to expected format
fang-xing-esql added a commit to fang-xing-esql/Elasticsearch that referenced this pull request Feb 4, 2025
…rmat (elastic#121585)

* change function_named_parameters in kibana doc to expected format
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
9.0
8.18
8.x

fzowl pushed a commit to voyage-ai/elasticsearch that referenced this pull request Feb 4, 2025
…rmat (elastic#121585)

* change function_named_parameters in kibana doc to expected format
elasticsearchmachine pushed a commit that referenced this pull request Feb 4, 2025
…rmat (#121585) (#121687)

* change function_named_parameters in kibana doc to expected format
elasticsearchmachine pushed a commit that referenced this pull request Feb 4, 2025
…rmat (#121585) (#121688)

* change function_named_parameters in kibana doc to expected format
elasticsearchmachine pushed a commit that referenced this pull request Feb 4, 2025
…rmat (#121585) (#121689)

* change function_named_parameters in kibana doc to expected format
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Analytics/ES|QL AKA ESQL auto-backport Automatically create backport pull requests when merged >docs General docs changes ES|QL-ui Impacts ES|QL UI Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v8.18.0 v8.18.1 v8.19.0 v9.0.0 v9.0.1 v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants